<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Anemometer</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Anemometer</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">class Anemometer</p>
<p class="description"><p>This is the controller class for the Box Anemometer web application.</p><p>It is designed to closely resemble Codeigniter, so it can be easily added to  a CI installation (untested.)</p><p>Public method represent controller actions, callable through the index.php</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Gavin Towey &lt;<a href="mailto:gavin@box.com">gavin@box.com</a>&gt; and Geoff Anderson &lt;geoff@box.com&gt;</li>
				<li><span class="field">license:</span> please</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Anemometer.php.html">/Anemometer.php</a> (line <span class="field">21</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																												
												<div class="method-definition">
											<span class="method-result">Anemometer</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">type</span>&nbsp;<span class="var-name">$conf</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#api" title="details" class="method-name">api</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#graph_search" title="details" class="method-name">graph_search</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#index" title="details" class="method-name">index</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#quicksearch" title="details" class="method-name">quicksearch</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#report" title="details" class="method-name">report</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#samples" title="details" class="method-name">samples</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#show_query" title="details" class="method-name">show_query</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#upd_query" title="details" class="method-name">upd_query</a>
										()
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">33</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor.  Pass in the global configuration object</p>
	
	<div class="method-signature">
		<span class="method-result">Anemometer</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">type</span>&nbsp;<span class="var-name">$conf</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">type</span>
				<span class="var-name">$conf</span>			</li>
				</ul>
		
			
	</div>
<a name="methodapi" id="api"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">api</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">main method for getting report results.  This method can be called as an  ajax callback and return the raw data in json format, or it can display  a table or graph directly.  All other methods that get report results use this  either directly or as an ajax call.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			api
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgraph_search" id="graph_search"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">graph_search</span> (line <span class="line-number">95</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Search by using a graph.  A brief search form is shown to allow a graph to  be built.  Html table results that corespond to the time range of the graph is  displayed below.  Regions can be selected in the graph directly which will  update the table results with the new time range.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			graph_search
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodindex" id="index"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">index</span> (line <span class="line-number">136</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">show the index page where users can select the datasource.  If there's only</p>
<p class="description"><p>one, just redirect to the default report</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			index
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodquicksearch" id="quicksearch"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">quicksearch</span> (line <span class="line-number">162</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Search for a checksum value.  Redirect to show_query if it's found</p>
<p class="description"><p>or display an error message</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			quicksearch
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodreport" id="report"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">report</span> (line <span class="line-number">181</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Display the search form, and the report results (by default as a html table)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			report
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsamples" id="samples"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">samples</span> (line <span class="line-number">221</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show query samples for a specific checksum</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			samples
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodshow_query" id="show_query"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">show_query</span> (line <span class="line-number">251</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Display a specific query from its checksum value</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			show_query
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodupd_query" id="upd_query"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">upd_query</span> (line <span class="line-number">308</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Update the review and comments for a query by its checksum</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			upd_query
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Mon, 12 Mar 2012 11:59:40 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>